Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update to square size 128 #1880

Merged
merged 3 commits into from
Jan 29, 2025
Merged

docs: update to square size 128 #1880

merged 3 commits into from
Jan 29, 2025

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Jan 28, 2025

Overview

Resolves #1879

Summary by CodeRabbit

  • Documentation
    • Updated mainnet guide with new maximum square size calculations
    • Increased governance maximum square size from 64 to 128
    • Updated total blob size in transactions from approximately 2 MiB to approximately 8 MiB
    • Adjusted the number of shares available after reserving one for the PFB transaction from 4095 to 16383

@jcstein jcstein requested a review from rootulp January 28, 2025 21:54
Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

Warning

Rate limit exceeded

@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 26 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 7dd88d5 and be33f65.

📒 Files selected for processing (1)
  • how-to-guides/mainnet.md (1 hunks)

Walkthrough

The pull request updates the Celestia mainnet documentation to reflect an increase in the maximum square size from 64 to 128. This change impacts the total blob size allowed in transactions, expanding it from approximately 2 MiB to 8 MiB. The documentation specifically updates the numerical values related to network parameters, including the number of shares and total bytes calculation, while maintaining the overall document structure.

Changes

File Change Summary
how-to-guides/mainnet.md Updated maximum square size from 64 to 128, recalculated total blob size and shares

Assessment against linked issues

Objective Addressed Explanation
Update mainnet documentation for square size 128 [#1879]

Possibly related PRs

Suggested labels

documentation, P0

Suggested reviewers

  • Bidon15
  • distractedm1nd
  • rootulp

Poem

🐰 Squares grow larger, bytes take flight,
From 64 to 128, a network's might!
Shares expanding, data's new dance,
Celestia's docs get an upgrade's glance.
Hop, hop, hurrah for progress bright! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

github-actions bot commented Jan 28, 2025

PR Preview Action v1.6.0

🚀 View preview at
https://celestiaorg.github.io/docs-preview/pr-1880/

Built to branch main at 2025-01-28 22:11 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

how-to-guides/mainnet.md Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1e014f8 and 7dd88d5.

📒 Files selected for processing (1)
  • how-to-guides/mainnet.md (1 hunks)
🔇 Additional comments (2)
how-to-guides/mainnet.md (2)

60-61: LGTM!

The calculations for total shares (128×128 = 16384) and remaining shares (16384 - 1 = 16383) are mathematically correct.


69-69: LGTM!

The total bytes calculation is mathematically correct:

  • First share: 1 × 478 = 478 bytes
  • Remaining shares: 16382 × 482 = 7,896,124 bytes
  • Total: 478 + 7,896,124 = 7,896,602 bytes

Comment on lines 55 to 56
governance maximum square size is 128, the total blob size in a transaction
must be slightly less than ~8 MiB, or 7,895,546 bytes to be exact.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Verify the exact byte count.

The stated exact byte count (7,895,546) differs from the calculation result in line 69 (7,896,602). This inconsistency should be resolved.

Apply this diff to fix the inconsistency:

-must be slightly less than ~8 MiB, or 7,895,546 bytes to be exact.
+must be slightly less than ~8 MiB, or 7,896,602 bytes to be exact.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
governance maximum square size is 128, the total blob size in a transaction
must be slightly less than ~8 MiB, or 7,895,546 bytes to be exact.
governance maximum square size is 128, the total blob size in a transaction
must be slightly less than ~8 MiB, or 7,896,602 bytes to be exact.

how-to-guides/mainnet.md Outdated Show resolved Hide resolved
@jcstein jcstein requested a review from rootulp January 28, 2025 22:10
@jcstein jcstein merged commit 95121b3 into main Jan 29, 2025
6 checks passed
@jcstein jcstein deleted the jcs/update-128 branch January 29, 2025 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: update mainnet for square size 128
2 participants